home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 1 Issue 2 / PDCD-1 - Issue 02.iso / _utilities / utilities / 001 / meschach / !Meschach / DOC / fnindex next >
Text File  |  1994-01-14  |  17KB  |  405 lines
  1.  
  2.                   FUNCTION INDEX
  3.                   ==============
  4.  
  5. In the descriptions below, matrices are represented by capital letters,
  6. vectors by lower case letters and scalars by alpha.
  7.  
  8.  Function    Description
  9.  
  10. band2mat()    Convert band matrix to dense matrix
  11. bd_free()    Deallocate (destroy) band matrix
  12. bd_get()    Allocate and initialise band matrix
  13. bd_transp()    Transpose band matrix
  14. bd_resize()    Resize band matrix
  15. bdLDLfactor()    Band  LDL^T  factorisation
  16. bdLDLsolve()    Solve  Ax=b  using band  LDL^T  factors
  17. bdLUfactor()    Band  LU  factorisation
  18. bdLUsolve()    Solve  Ax=b  using band  LU  factors
  19. bisvd()        SVD of bi-diagonal matrix
  20. BKPfactor()    Bunch-Kaufman-Parlett factorisation
  21. BKPsolve()    Bunch-Kaufman-Parlett solver
  22. catch()        Catch a raised error (macro)
  23. catchall()    Catch any raised error (macro)
  24. catch_FPE()    Catch floating point error (sets flag)
  25. CHfactor()    Dense Cholesky factorisation
  26. CHsolve()    Cholesky solver
  27. d_save()    Save real in MATLAB format
  28. Dsolve()    Solve  Dx=y ,  D  diagonal
  29. ERRABORT()    Abort on error (sets flag, macro)
  30. ERREXIT()    Exit on error (sets flag, macro)
  31. error()        Raise an error (macro, see  ev_err())
  32. err_list_attach()     Attach new list of errors
  33. err_list_free()             Discard list of errors
  34. err_is_list_attached()     Checks for an error list
  35. ev_err()    Raise an error (function)
  36. fft()        Computes Fast Fourier Transform
  37. finput()    Input a simple data item from a stream
  38. fprompter()    Print prompt to  stderr
  39. get_col()    Extract a column from a matrix
  40. get_row()    Extract a row from a matrix
  41. givens()    Compute Givens parameters
  42. hhtrcols()    Compute  AP^T  where  P  is a Householder matrix
  43. hhtrrows()    Compute  PA  where  P  is a Householder matrix
  44. hhtrvec()    Compute  Px  where  P  is a Householder matrix
  45. hhvec()        Compute parameters for a Householder matrix
  46. ifft()        Computes inverse FFT
  47. in_prod()    Inner product of vectors
  48. input()        Input a simple data item from  stdin (macro)
  49. iter_arnoldi()    Arnoldi iterative method
  50. iter_arnoldi_iref()    Arnoldi iterative method with refinement
  51. iter_ATx()    Set  A^T  in ITER structure
  52. iter_Ax()    Set  A  in ITER structure
  53. iter_Bx()    Set preconditioner in ITER structure
  54. iter_cg()    Conjugate gradients iterative method
  55. iter_cgne()     Conjugate gradients for normal equations
  56. iter_cgs()    CGS iterative method
  57. iter_copy()    Copy ITER data structures
  58. iter_copy2()    Shallow copy of ITER data structures
  59. iter_dump()    Dump ITER data structure to a stream
  60. iter_free()    Free (deallocate) ITER structure
  61. iter_get()    Allocate ITER structure
  62. iter_gmres()    GMRES iterative method
  63. iter_lanczos()    Lanczos iterative method
  64. iter_lanczos2()    Lanczos method with Cullum and Willoughby extensions
  65. iter_lsqr()    LSQR iterative method
  66. iter_mgcr()    MGCR iterative method
  67. iter_resize()    Resize vectors in an ITER data structure
  68. iter_spcg()    Sparse matrix CG method
  69. iter_spcgne()   Sparse matrix CG method for normal equations
  70. iter_spcgs()    Sparse matrix CGS method
  71. iter_spgmres()  Sparse matrix GMRES method
  72. iter_splsqr()    Sparse matrix LSQR method
  73. iter_spmgcr()    Sparse matrix MGCR method
  74. iv_add()    Add integer vectors
  75. iv_copy()    Copy integer vector
  76. iv_dump()    Dump integer vector to a stream
  77. iv_finput()    Input integer vector from a stream
  78. iv_foutput()    Output integer vector to a stream
  79. IV_FREE()    Free (deallocate) an integer vector (macro)
  80. iv_free()    Free (deallocate) integer vector (function)
  81. iv_free_vars()    Free a list of integer vectors
  82. iv_get()    Allocate and initialise an integer vector
  83. iv_get_vars()    Allocate list of integer vectors
  84. iv_input()    Input integer vector from  stdin (macro)
  85. iv_output()    Output integer vector to  stdout (macro)
  86. iv_resize()    Resize an integer vector
  87. iv_resize_vars()    Resize a list of integer vectors
  88. iv_sub()    Subtract integer vectors
  89. LDLfactor()    LDL^T  factorisation
  90. LDLsolve()    LDL^T  solver
  91. LDLupdate()    Update  LDL^T  factorisation
  92. Lsolve()    Solve  Lx=y ,  L  lower triangular
  93. LTsolve()    Solve  L^Tx=y ,  L  lower triangular
  94. LUcondest()    Estimate a condition number using  LU  factors
  95. LUfactor()    Compute  LU  factors with implicit scaled partial pivoting
  96. LUsolve()    Solve  Ax=b  using  LU  factors
  97. LUTsolve()    Solve  A^Tx=b  usng  LU  factors
  98. m_add()            Add matrices
  99. makeQ()            Form Q matrix for QR factorisation
  100. makeR()            Form R matrix for QR factorisation
  101. mat2band()    Extract band matrix from dense matrix
  102. MCHfactor()    Modified Cholesky factorisation 
  103.         (actually factors A+D, D diagonal, instead of A)
  104. m_copy()    Copy dense matrix
  105. m_dump()    Dump matrix data structure to a stream
  106. mem_attach_list()    Adds a new family of types
  107. mem_bytes()            Notify change in memory usage (macro)
  108. mem_bytes_list()    Notify change in memory usage
  109. mem_free_list()            Frees a family of types
  110. mem_info_bytes()    Number of bytes used by a type
  111. mem_info_numvar()    Number of structures of a type
  112. mem_info_file()            Print memory info to a stream
  113. mem_info_is_on()    Is memory data being accumulated?
  114. mem_info_on()            Turns memory info system on/off
  115. mem_is_list_attached()    Is list of types attached?
  116. mem_numvar()            Notify change in number of structures allocated (macro)
  117. mem_numvar_list()    Notify change in number of structures allocated
  118. mem_stat_dump()    Prints information on registered workspace
  119. mem_stat_free()    Frees (deallocates) static workspace
  120. mem_stat_mark()    Sets mark for workspace
  121. MEM_STAT_REG()    Register static workspace (macro)
  122. mem_stat_show_mark()    Current workspace group
  123. m_exp()        Computes matrix exponential
  124. m_finput()    Input matrix from a stream
  125. m_foutput()    Output matrix to a stream
  126. M_FREE()    Free (deallocate) a matrix (macro)
  127. m_free()    Free (deallocate) matrix (function)
  128. m_free_vars()    Free a list of matrices
  129. m_get()            Allocate and initialise a matrix
  130. m_get_vars()    Allocate list of matrices
  131. m_ident()    Sets matrix to identity matrix
  132. m_input()    Input matrix from  stdin (macro)
  133. m_inverse()    Invert matrix
  134. m_load()    Load matrix in MATLAB format
  135. m_mlt()            Multiplies matrices
  136. mmtr_mlt()    Computes  AB^T 
  137. m_norm1()    Computes  ||A||_1  of a matrix
  138. m_norm_frob()    Computes the Frobenius norm of a matrix
  139. m_norm_inf()    Computes  ||A||_inf  of a matrix
  140. m_ones()    Set matrix to all 1's
  141. m_output()    Output matrix to stdout (macro)
  142. m_poly()    Computes a matrix polynomial
  143. m_pow()        Computes integer power of a matrix
  144. mrand()        Generates pseudo-random real number
  145. m_rand()    Randomise entries of a matrix
  146. mrandlist()    Generates array of pseudo-random numbers
  147. m_resize()    Resize matrix
  148. m_resize_vars()    Resize a list of matrices
  149. m_save()    Save matrix in MATLAB format
  150. m_sub()        Subtract matrices
  151. m_transp()    Transpose matrix
  152. mtrm_mlt()    Computes  A^TB 
  153. mv_mlt()    Computes  Ax 
  154. mv_mltadd()    Computes  y <- Ax+y 
  155. m_zero()    Zero a matrix
  156. ON_ERROR()    Error handler (macro)
  157. prompter()    Print prompt message to  stdout
  158. px_cols()    Permute the columns of a matrix
  159. px_copy()    Copy permutation
  160. px_dump()    Dump permutation data structure to a stream
  161. px_finput()    Input permutation from a stream
  162. px_foutput()    Output permutation to a stream
  163. PX_FREE()    Free (deallocate) a permutation (macro)
  164. px_free()    Free (deallocate) permutation (function)
  165. px_free_vars()    Free a list of permutations
  166. px_get()    Allocate and initialise a permutation
  167. px_get_vars()    Allocate a list of permutations
  168. px_ident()    Sets permutation to identity
  169. px_input()    Input permutation from  stdin (macro)
  170. px_inv()    Invert permutation
  171. pxinv_vec()    Computes  P^Tx  where  P  is a permutation matrix
  172. pxinv_zvec()    Computes  P^Tx  where  P  is a permutation matrix (complex)
  173. px_mlt()    Multiply permutations
  174. px_output()    Output permutation to  stdout (macro)
  175. px_resize()    Resize a permutation
  176. px_resize_vars()    Resize a list of permutations
  177. px_rows()    Permute the rows of a matrix
  178. px_sign()    Returns the sign of the permutation
  179. px_transp()    Transpose a pair of entries
  180. px_vec()    Computes  Px  where  P  is a permutation matrix
  181. px_zvec()    Computes  Px  where  P  is a permutation matrix (complex)
  182. QRCPfactor()    QR factorisation with column pivoting
  183. QRfactor()    QR factorisation
  184. QRsolve()    Solve  Ax=b  using  QR  factorisation
  185. QRTsolve()    Solve  A^Tx=b  using  QR  factorisation
  186. QRupdate()    Update explicit  QR  factors
  187. rot_cols()    Apply Givens rotation to the columns of a matrix
  188. rot_rows()    Apply Givens rotation to the rows of a matrix
  189. rot_vec()    Apply Givens rotation to a vector
  190. rot_zvec()    Apply complex Givens rotation to a vector
  191. schur()        Compute real Schur form
  192. schur_evals()    Compute eigenvalues from the real Schur form
  193. schur_vecs()    Compute eigenvectors from the real Schur form
  194. set_col()    Set the column of a matrix to a given vector
  195. set_err_flag()    Control behaviour of  ev_err()
  196. set_row()    Set the row of a matrix to a given vector
  197. sm_mlt()    Scalar-matrix multiplication
  198. smrand()    Set seed for mrand()
  199. spBKPfactor()    Sparse symmetric indefinite factorsiation
  200. spBKPsolve()    Sparse symmetric indefinite solver
  201. spCHfactor()    Sparse Cholesky factorisation
  202. spCHsolve()    Sparse Cholesky solver
  203. spCHsymb()    Symbolic sparse Cholesky factorisation 
  204.         (no floating point operations)
  205. sp_col_access()    Sets up column access paths for a sparse matrix
  206. sp_compact()    Eliminates zero entries in a sparse matrix
  207. sp_copy()    Copies a sparse matrix
  208. sp_copy2()    Copies a sparse matrix into another
  209. sp_diag_access()    Sets up diagonal access paths for a sparse matrix
  210. sp_dump()    Dump sparse matrix data structure to a stream
  211. sp_finput()    Input sparse matrix from a stream
  212. sp_foutput()    Output a sparse matrix to a stream
  213. sp_free()    Free (deallocate) a sparse matrix
  214. sp_get()    Allocate and initialise a sparse matrix
  215. sp_get_val()    Get the  (i,j)  entry of a sparse matrix
  216. spICHfactor()    Sparse incomplete Cholesky factorisation
  217. sp_input()    Input a sparse matrix form  stdin
  218. spLUfactor()    Sparse  LU  factorisation using partial pivoting
  219. spLUsolve()    Solves  Ax=b  using sparse  LU  factors
  220. spLUTsolve()    Solves  A^Tx=b  using sparse  LU  factors
  221. sp_mv_mlt()    Computes  Ax  for sparse  A 
  222. sp_output()    Outputs a sparse matrix to a stream (macro)
  223. sp_resize()    Resize a sparse matrix
  224. sprow_add()    Adds a pair of sparse rows
  225. sprow_foutput()    Output sparse row to a stream
  226. sprow_get()    Allocate and initialise a sparse row
  227. sprow_get_idx()    Get location of an entry in a sparse row
  228. sprow_merge()    Merge two sparse rows
  229. sprow_mltadd()    Sparse row vector multiply-and-add
  230. sprow_set_val()    Set an entry in a sparse row
  231. sprow_smlt()    Multiplies a sparse row by a scalar
  232. sprow_sub()    Subtracts a sparse row from another
  233. sprow_xpd()    Expand a sparse row
  234. sp_set_val()    Set the  (i,j)  entry of a sparse matrix
  235. sp_vm_mlt()    Compute  x^TA  for sparse  A 
  236. sp_zero()    Zero (but do not remove) all entries of a sparse matrix
  237. svd()        Compute the SVD of a matrix
  238. sv_mlt()    Scalar-vector multiply
  239. symmeig()    Compute eigenvalues/vectors of a symmetric matrix
  240. tracecatch()    Catch and re-raise errors (macro)
  241. trieig()    Compute eigenvalues/vectors of a symmetric tridiagonal matrix
  242. Usolve()    Solve  Ux=b  where  U  is upper triangular
  243. UTsolve()    Solve  U^Tx=b  where  U  is upper triangular
  244. v_add()        Add vectors
  245. v_conv()    Convolution product of vectors
  246. v_copy()    Copy vector
  247. v_dump()    Dump vector data structure to a stream
  248. v_finput()    Input vector from a stream
  249. v_foutput()    Output vector to a stream
  250. V_FREE()    Free (deallocate) a vector (macro)
  251. v_free()    Free (deallocate) vector (function)
  252. v_free_vars()    Free a list of vectors
  253. v_get()        Allocate and initialise a vector
  254. v_get_vars()    Allocate list of vectors
  255. v_input()    Input vector from  stdin (macro)
  256. v_lincomb()    Compute  sum of a_i x_i  for an array of vectors
  257. v_linlist()    Compute  sum of a_i x_i  for a list of vectors
  258. v_map()        Apply function componentwise to a vector
  259. v_max()        Computes max vector entry and index
  260. v_min()        Computes min vector entry and index
  261. v_mltadd()    Computes  y <- alpha*x+y  for vectors  x ,  y 
  262. vm_mlt()    Computes  x^TA 
  263. vm_mltadd()    Computes  y^T <- y^T+x^TA 
  264. v_norm1()    Computes  ||x||_1  for a vector
  265. v_norm2()    Computes  ||x||_2  (the Euclidean norm) of a vector
  266. v_norm_inf()    Computes  ||x||_inf  for a vector
  267. v_ones()    Set vector to all 1's
  268. v_output()    Output vector to  stdout (macro)
  269. v_pconv()    Periodic convolution of two vectors
  270. v_rand()    Randomise entries of a vector
  271. v_resize()    Resize a vector
  272. v_resize_vars()    Resize a list of vectors
  273. v_save()    Save a vector in MATLAB format
  274. v_slash()    Computes componentwise ratio of vectors
  275. v_sort()    Sorts vector components
  276. v_star()    Componentwise vector product
  277. v_sub()        Subtract two vectors
  278. v_sum()        Sum of components of a vector
  279. v_zero()    Zero a vector
  280. zabs()        Complex absolute value (modulus)
  281. zadd()        Add complex numbers
  282. zconj()        Conjugate complex number
  283. zdiv()        Divide complex numbers
  284. zexp()        Complex exponential
  285. z_finput()    Read complex number from file or stream
  286. z_foutput()    Prints complex number to file or stream
  287. zgivens()    Compute complex Givens' rotation
  288. zhhtrcols()    Apply Householder transformation:  PA  (complex)
  289. zhhtrrows()    Apply Householder transformation:  AP  (complex)
  290. zhhtrvec()    Apply Householder transformation:  Px  (complex)
  291. zhhvec()    Compute Householder transformation
  292. zin_prod()    Complex inner product
  293. z_input()    Read complex number from stdin
  294. zinv()        Computes  1/z  (complex)
  295. zLAsolve()    Solve  L^*x=b ,  L  complex lower triangular
  296. zlog()        Complex logarithm
  297. zLsolve()    Solve  Lx=b ,  L  complex lower triangular
  298. zLUAsolve()    Solve  A^*x=b  using complex LU factorisation 
  299.         (A^* - adjoint of A, A is complex)
  300. zLUcondest()    Complex LU condition estimate
  301. zLUfactor()    Complex LU factorisation
  302. zLUsolve()    Solve  Ax=b  using complex LU factorisation
  303. zm_add()    Add complex matrices
  304. zm_adjoint()    Computes adjoint of complex matrix
  305. zmake()        Construct complex number from real and imaginary parts
  306. zmakeQ()    Construct  Q  matrix for complex  QR 
  307. zmakeR()    Construct  R  matrix for complex  QR 
  308. zmam_mlt()    Computes  A^*B  (complex)
  309. zm_dump()    Dump complex matrix to stream
  310. zm_finput()    Input complex matrix from stream
  311. ZM_FREE()    Free (deallocate) complex matrix (macro)
  312. zm_free()    Free (deallocate) complex matrix (function)
  313. zm_free_vars()    Free a list of complex matrices
  314. zm_get()    Allocate complex matrix
  315. zm_get_vars()    Allocate a list of complex matrices
  316. zm_input()    Input complex matrix from stdin
  317. zm_inverse()    Compute inverse of complex matrix
  318. zm_load()    Load complex matrix in MATLAB format
  319. zmlt()        Multiply complex numbers
  320. zmma_mlt()    Computes  AB^*  (complex)
  321. zm_mlt()    Multiply complex matrices
  322. zm_norm1()    Complex matrix 1-norm
  323. zm_norm_frob()    Complex matrix Frobenius norm
  324. zm_norm_inf()    Complex matrix infinity-norm
  325. zm_rand()    Randomise complex matrix
  326. zm_resize()    Resize complex matrix
  327. zm_resize_vars()    Resize a list of complex matrices
  328. zm_save()    Save complex matrix in MATLAB format
  329. zm_sub()    Subtract complex matrices
  330. zmv_mlt()    Complex matrix-vector multiply
  331. zmv_mltadd()    Complex matrix-vector multiply and add
  332. zm_zero()    Zero complex matrix
  333. zneg()        Computes  -z  (complex)
  334. z_output()    Print complex number to stdout
  335. zQRCPfactor()    Complex  QR  factorisation with column pivoting
  336. zQRCPsolve()    Solve  Ax = b  using complex  QR  factorisation
  337. zQRfactor()    Complex  QR  factorisation
  338. zQRAsolve()    Solve  A^*x = b  using complex  QR  factorisation
  339. zQRsolve()    Solve  Ax = b  using complex  QR  factorisation
  340. zrot_cols()    Complex Givens' rotation of columns
  341. zrot_rows()    Complex Givens' rotation of rows
  342. z_save()    Save complex number in MATLAB format
  343. zschur()    Complex Schur factorisation
  344. zset_col()    Set column of complex matrix
  345. zset_row()    Set row of complex matrix
  346. zsm_mlt()    Complex scalar-matrix product
  347. zsqrt()        Square root  z  (complex)
  348. zsub()        Subtract complex numbers
  349. zUAsolve()    Solve  U^*x=b ,  U  complex upper triangular
  350. zUsolve()    Solve  Ux=b ,  U  complex upper triangular
  351. zv_add()    Add complex vectors
  352. zv_copy()    Copy complex vector
  353. zv_dump()    Dump complex vector to a stream
  354. zv_finput()    Input complex vector from a stream
  355. ZV_FREE()    Free (deallocate) complex vector (macro)
  356. zv_free()    Free (deallocate) complex vector (function)
  357. zv_free_vars()    Free a list of complex vectors
  358. zv_get()    Allocate complex vector
  359. zv_get_vars()    Allocate a list of complex vectors
  360. zv_input()    Input complex vector from a stdin
  361. zv_lincomb()    Compute  sum of a_i x_i  for an array of vectors
  362. zv_linlist()    Compute  sum of a_i x_i  for a list of vectors
  363. zv_map()    Apply function componentwise to a complex vector
  364. zv_mlt()    Complex scalar-vector product
  365. zv_mltadd()    Complex scalar-vector multiply and add
  366. zvm_mlt()    Computes  A^*x  (complex)
  367. zvm_mltadd()    Computes  A^*x+y  (complex)
  368. zv_norm1()    Complex vector 1-norm    vnorm1()
  369. zv_norm2()    Complex vector 2-norm  (Euclidean norm)
  370. zv_norm_inf()    Complex vector infinity- (or supremum) norm
  371. zv_rand()    Randomise complex vector
  372. zv_resize()    Resize complex vector
  373. zv_resize_vars()    Resize a list of complex vectors
  374. zv_save()    Save complex vector in MATLAB format
  375. zv_slash()    Componentwise ratio of complex vectors
  376. zv_star()    Componentwise product of complex vectors
  377. zv_sub()    Subtract complex vectors
  378. zv_sum()    Sum of components of a complex vector
  379. zv_zero()    Zero complex vector
  380.  
  381.  
  382.  
  383.                 Low level routines
  384.  
  385.  
  386.  Function    Description
  387.  
  388. __add__()    Add arrays
  389. __ip__()    Inner product of arrays
  390. MEM_COPY()    Copy memory (macro)
  391. MEM_ZERO()    Zero memory (macro)
  392. __mltadd__()    Forms  x+ alpha*y  for arrays
  393. __smlt__()    Scalar-vector multiplication for arrays
  394. __sub__()    Subtract an array from another
  395. __zadd__()    Add complex arrays
  396. __zconj__()    Conjugate complex array
  397. __zero__()    Zero an array
  398. __zip__()    Complex inner product of arrays
  399. __zmlt__()    Complex array scalar product
  400. __zmltadd__()    Complex array saxpy
  401. __zsub__()    Subtract complex arrays
  402. __zzero__()    Zero a complex array
  403.  
  404.  
  405.